/**
 * Copyright 2011 Andreas Kaubisch
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/
package de.easymessage;

/**
 * This Interface provides a possibility to publish a message to a channel
 * 
 * @author ank
 * 
 * @param <T>
 */
public interface ChannelPublisher<T> {

	/**
	 * Returns the {@link Channel} where its publish the message
	 * 
	 * @return a {@link Channel}
	 */
	public abstract Channel<T> getChannel();

	/**
	 * Sets the current channel
	 * 
	 * @param channel
	 */
	public abstract void setChannel(Channel<T> channel);

	/**
	 * Publishs the message to all {@link ChannelListener} objects registered
	 * with a channel that must be given earlier with
	 * {@link ChannelPublisher#setChannel(Channel)}
	 * 
	 * @param channelMessage the message that must be published
	 */
	public abstract void publish(ChannelMessage<T> channelMessage);

}